NEW  Adding custom columns

By default, the Publisher Queue web page shows basic information (columns) about each publishing job in the queue. The rows in queue can be filtered by any column as described in the BlueCielo Publisher User's Guide.

For most environments, the default columns are adequate but if the queue is typically very long, the default columns may be insufficient to filter specific documents. For such environments, you can add up to five custom columns to the Publisher database and configure the Publisher Queue to show the columns where you can filter them.

Before you begin

This task requires administrator access to the Publisher database in order to extend the schema. The database user account that is used by the Publisher to access the database is specified as described in Configuring the BlueCielo Application Manager.

To add custom columns:

1. Using the tools of the database management system where the Publisher database is hosted, add up to five columns to the Publish table in the BlueCieloConfig database. You can specify any column names. The columns names and the labels shown in the queue page are specified in the next step.
2. Configure the web application to show the new columns:
   1. Locate and open the Publisher web.config file in any text editor. By default, it is located in the default website folder.

   2. Locate and modify or add the QueueCustomColumns setting in the file similar to the following example. The syntax of each column (<string> element) is:

      <ColumnName>;<ColumnLabel>;<IsHiddenOnQueuePage>;<IsHiddenOnDetailsPage>

   3. Save your changes and close the file.

<setting name="QueueCustomColumns" serializeAs="Xml">
  <value>
     <ArrayOfString xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:xsd="http://www.w3.org/2001/XMLSchema">
       <string>Column1;Column 1</string>
       <string>Column2;Column 2;True</string>
       <string>Column3;Column 3;</string>
       <string>Column4;Column 4</string>
       <string>Column5;Column 5;;True</string>
     </ArrayOfString>
  </value>
</setting>

To use the new columns, you must provide values for them in the VBScript code that registers the documents for publishing similar to the following examples.

Example without the Task Server

Sub PublishCommand_Execute(Batch)
 
  On Error Resume Next
  Dim customColumns
  customColumns = Array( _
		Array("Column1", "Value1"), _
		Array("Column2", Document.FileName), _ 
		Array("Column3", Document.Size), _ 
		Array("Column4", Document.Created), _        
		Array("Column5", True) _        
	)
      
  'Create the script object.
  Set Publisher = New PublisherScriptObject  
  'Register the selected document for publishing.
  Call Publisher.Queue.RegisterDocument("", "BCM - FS", Document.ID, , , , , ,"", _
                                        customColumns)     

  'Release the script object.
  Set Publisher = Nothing   
  If Err.Number <> 0 Then  
	  WinMsgBox "Publish failed: " +  Err.Description
      Err.Clear 
  End If
End Sub

Example with the Task Server

Note    All unknown property assignments passed to the BCPublisher.MeridianTask object are considered as custom column names and values. For more information about the properties, see The MeridianTask object properties.

Sub Publish_TaskServer_Execute(Batch)
	' Set arguments for the task.
	Vault.Task.Set "JobCode", "BCM - FS"    
    
	Vault.Task.Set "Column1", "Value1"
	Vault.Task.Set "Column2", Document.FileName
	Vault.Task.Set "Column3", Document.Size
	' DateTime value must be passed as a formatted string
	Vault.Task.Set "Column4", FormatDateTime(Document.Created)
	' Boolean value must be passed as 1-True, 0-False
	Vault.Task.Set "Column5", 1

	' Register the selected document for publishing.
	Vault.Task.Submit "BCPublisher.MeridianTask", Document
End Sub